home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / migcmd / RCS / migcmd.man,v < prev    next >
Encoding:
Text File  |  1990-02-16  |  9.6 KB  |  332 lines
  1. head     1.5;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.5
  10. date     90.02.16.11.08.38;  author douglis;  state Exp;
  11. branches ;
  12. next     1.4;
  13.  
  14. 1.4
  15. date     89.04.07.14.24.33;  author douglis;  state Exp;
  16. branches ;
  17. next     1.3;
  18.  
  19. 1.3
  20. date     88.12.30.09.50.53;  author ouster;  state Exp;
  21. branches ;
  22. next     1.2;
  23.  
  24. 1.2
  25. date     88.12.22.10.02.52;  author ouster;  state Exp;
  26. branches ;
  27. next     1.1;
  28.  
  29. 1.1
  30. date     88.12.06.13.49.37;  author douglis;  state Exp;
  31. branches ;
  32. next     ;
  33.  
  34.  
  35. desc
  36. @manual page for migcmd.
  37. @
  38.  
  39.  
  40. 1.5
  41. log
  42. @better documentation
  43. @
  44. text
  45. @' $Header: /a/newcmds/migcmd/RCS/migcmd.man,v 1.4 89/04/07 14:24:33 douglis Exp Locker: douglis $ SPRITE (Berkeley)
  46. .so \*(]ltmac.sprite
  47. .HS MIGCMD cmds
  48. .BS
  49. .SH NAME
  50. migcmd \- Print or update information relating to process migration
  51. .SH SYNOPSIS
  52. \fBmigcmd\fR [\fB\-sSZptT\fR] [\fB\-[IE] (none|all|root)\fR] [\fB\-[il] (0|1)\fR] [\fB\-l (0|1)\fR] [\fB\-P \fInumRecs\fR] [\fB\-d \fIdebugLevel\fR] [\fB\-V \fImigrationVersion\fR] 
  53. .SH OPTIONS
  54. .IP "\fB\-s\fR" 20
  55. A message is printed to indicate the status of process migration on the 
  56. current host, including the migration level and the conditions under
  57. which migration is permitted.
  58. .IP "\fB\-S\fR" 20
  59. Migration statistics are printed.  These include such values as the
  60. average time to migrate an active process, the average time to perform
  61. a remote exec, and the total number of migrations, evictions, and
  62. remote execs performed.
  63. .IP "\fB\-Z\fR" 20
  64. The kernel migrations statistics are reset to 0.
  65. .IP "\fB\-I\fR" 20
  66. Change the import restrictions for process migration.  (The caller must be root.)
  67. .IP "\fB\-E\fR" 20
  68. Change the export restrictions for process migration.  (The caller must be root.)
  69. .IP "\fB\-i\fR" 20
  70. Change whether idle time is considered when determining the availability of 
  71. this host.  (The caller must be root.)
  72. .IP "\fB\-l\fR" 20
  73. Change whether load average is considered when determining the availability of 
  74. this host.  (The caller must be root.)
  75. .IP "\fB\-p\fR" 20
  76. Process migration trace records are printed.  The number of records
  77. may be altered by the \fB\-P\fR option.
  78. .IP "\fB\-P \fInumRecs\fR" 20
  79. The number of trace records to print is modified to be \fInumRecs\fR.  This
  80. option must be used with the \fB\-p\fR option.
  81. .IP "\fB\-t\fR" 20
  82. Process migration tracing is enabled for the current host.
  83. .IP "\fB\-T\fR" 20
  84. Process migration tracing is disabled for the current host.
  85. .IP "\fB\-d \fIdebugLevel\fR" 20
  86. The kernel process migration debug level is set to \fIdebugLevel\fR.
  87. .IP "\fB\-V \fImigrationVersion\fR" 20
  88. The kernel process migration version is set to \fImigrationVersion\fR.
  89. The caller must be root.
  90. .BE
  91. .SH INTRODUCTION
  92. .LP
  93. This command is used to perform functions related to process migration.
  94. \fBMigcmd\fR  is normally used to print the status of process migration 
  95. availability or migration statistics.  \fBMigcmd\fR may also be used
  96. to restrict which users may export or import processes from or to 
  97. the local host (the caller must be root to do so); change whether load
  98. average and/or idle time are considered when deciding whether the
  99. current host is available for imports;
  100. print process
  101. migration trace  records; enable or disable tracing of process
  102. migration activity; or set the kernel's migration ``debugging level''
  103. or ``migration version''.
  104. .SH "MIGRATION STATE"
  105. .LP
  106. \fBMigcmd\fR prints the status of process migration
  107. availability if the \fB\-s\fR flag is specified.
  108. As root, one may modify the restrictions on process migration.  For
  109. both exporting and importing processes, root may choose to restrict
  110. migration to processes owned by root, or not allow migration at all,
  111. or allow all users to migrate.  These options are specified to the
  112. \fB\-E\fR and \fB\-I\fR flags as \fBroot\fR, \fBnone\fR, and \fBall\fR
  113. respectively.  In addition, root is permitted to instruct the
  114. \fBloadavg\fR daemon whether to consider idle time and/or load average
  115. when announcing the availability of the host for importation.  These
  116. options are \fB\-i\fR and \fB\-l\fR, respectively, and take an integer
  117. argument: \fB1\fR specifies that the criterion should be ignored, and
  118. \fB0\fR specifies that it should be considered.
  119. .SH "STATISTICS"
  120. .LP
  121. The \fB-S\fR flag causes \fBMigcmd\fR  to print statistics on its
  122. standard output.  These statistics change too rapidly to list the
  123. format here.  The format is (hopefully) self-explanatory.
  124. .SH "TRACING"
  125. .LP
  126. The \fB\-p\fR flag may be used to dump process migration trace records.
  127. The maximum number of records defaults to 200 but may be modified with
  128. the \fB\-P\fR option.  By default, tracing is disabled and no trace
  129. records will be printed.  To enable tracing, one may specify the
  130. \fB\-t\fR flag, and to disable it, one may specify the \fB\-T\fR flag.  
  131. .SH "MIGRATION DEBUG LEVEL"
  132. .LP
  133. The kernel's debug level may be modified using the \fB\-d\fR  option.
  134. Subsequently higher values for the debug level will cause more
  135. debugging statements 
  136. to be executed. For example, to have no migration debugging enabled
  137. whatsoever, the level may be set to 0.  To enable error messages that
  138. indicate unusual but non-fatal events, the level may be 2 (this is the
  139. current default).  To enable more messages about the internal
  140. operation of migration within the kernel, such as forwarded system
  141. calls, the level may be set to values from 3-10.  ``Less interesting''
  142. events are conditioned on higher values of the debug level.
  143. .SH "MIGRATION VERSION"
  144. .LP
  145. The kernel's migration version may be modified by root using the
  146. \fB\-V\fR  option.  This should be done only when the kernel is
  147. compiled with an incorrect version for some reason, in order to cause
  148. the kernel to be compatible vis-a-vis migration with a different class
  149. of kernels.
  150. .SH "SEE ALSO"
  151. mig
  152. .SH KEYWORDS
  153. debug level, eviction, process migration, remote execution 
  154. @
  155.  
  156.  
  157. 1.4
  158. log
  159. @changed to handle new kernel state variable.
  160. @
  161. text
  162. @d1 1
  163. a1 1
  164. ' $Header: /a/newcmds/migcmd/RCS/migcmd.man,v 1.3 88/12/30 09:50:53 ouster Exp Locker: douglis $ SPRITE (Berkeley)
  165. d8 1
  166. a8 1
  167. \fBmigcmd\fR [\fB\-mptT\fR] [\fB\-[IE] (none|all|root)\fR]  [\fB\-[il] (0|1)\fR] [\fB\-l (0|1)\fR] [\fB\-P \fInumRecs\fR] [\fB\-d \fIdebugLevel\fR]
  168. d10 1
  169. a10 1
  170. .IP "\fB\-m\fR" 20
  171. d12 9
  172. a20 1
  173. current host.
  174. d43 3
  175. d50 3
  176. a52 2
  177. The default operation is to print the status of process migration 
  178. availability.  \fBMigcmd\fR may also be used to restrict which users may export or import processes from or to
  179. d58 2
  180. a59 1
  181. migration activity; or set the kernel's migration ``debugging level''.
  182. d62 2
  183. a63 3
  184. By default, \fBmigcmd\fR prints the status of process migration
  185. availability.
  186. This is also done if the \fB\-m\fR flag is specified.
  187. d75 5
  188. d99 7
  189. @
  190.  
  191.  
  192. 1.3
  193. log
  194. @More format upgrades.
  195. @
  196. text
  197. @d1 1
  198. a1 1
  199. ' $Header: /a/newcmds/migcmd/RCS/migcmd.man,v 1.2 88/12/22 10:02:52 ouster Exp $ SPRITE (Berkeley)
  200. d8 1
  201. a8 1
  202. \fBmigcmd\fR [\fB\-marptT\fR] [\fB\-P \fInumRecs\fR] [\fB\-d \fIdebugLevel\fR]
  203. d11 12
  204. a22 5
  205. A message is printed to indicate whether process migration is enabled.
  206. .IP "\fB\-a\fR" 20
  207. Process migration is enabled for the current host.  (The caller must be root.)
  208. .IP "\fB\-r\fR" 20
  209. Process migration is disabled for the current host.  (The caller must be root.)
  210. d39 6
  211. a44 3
  212. The default operation is to print whether process migration is
  213. enabled.  \fBMigcmd\fR may also be used to enable or disable migration to
  214. the local host (the caller must be root to do so); print process
  215. d49 14
  216. a62 4
  217. By default, \fBmigcmd\fR prints whether process migration is enabled on the
  218. current host.  This is also done if the \fB\-m\fR flag is specified.
  219. As root, one may disable or enable process migration using the
  220. \fB\-r\fR  (refuse) and \fB\-a\fR (accept) flags, respectively.
  221. @
  222.  
  223.  
  224. 1.2
  225. log
  226. @*** empty log message ***
  227. @
  228. text
  229. @d1 1
  230. a1 1
  231. ' $Header: /a/newcmds/migcmd/RCS/migcmd.man,v 1.1 88/12/06 13:49:37 douglis Exp $ SPRITE (Berkeley)
  232. d8 1
  233. a8 1
  234. \fBmigcmd\fR [\fB-marptT\fR] [\fB-P \fInumRecs\fR] [\fB-d \fIdebugLevel\fR]
  235. d10 1
  236. a10 1
  237. .IP "\fB-m\fR" 20
  238. d12 1
  239. a12 1
  240. .IP "\fB-a\fR" 20
  241. d14 1
  242. a14 1
  243. .IP "\fB-r\fR" 20
  244. d16 1
  245. a16 1
  246. .IP "\fB-p\fR" 20
  247. d18 2
  248. a19 2
  249. may be altered by the \fB-P\fR option.
  250. .IP "\fB-P \fInumRecs\fR" 20
  251. d21 2
  252. a22 2
  253. option must be used with the \fB-p\fR option.
  254. .IP "\fB-t\fR" 20
  255. d24 1
  256. a24 1
  257. .IP "\fB-T\fR" 20
  258. d26 1
  259. a26 1
  260. .IP "\fB-d \fIdebugLevel\fR" 20
  261. d33 1
  262. a33 1
  263. enabled.  Migcmd may also be used to enable or disable migration to
  264. d39 2
  265. a40 2
  266. By default, migcmd prints whether process migration is enabled on the
  267. current host.  This is also done if the \fB-m\fR flag is specified.
  268. d42 1
  269. a42 1
  270. \fB-r\fR  (refuse) and \fB-a\fR (accept) flags, respectively.
  271. d45 1
  272. a45 1
  273. The \fB-p\fR flag may be used to dump process migration trace records.
  274. d47 1
  275. a47 1
  276. the \fB-P\fR option.  By default, tracing is disabled and no trace
  277. d49 1
  278. a49 1
  279. \fB-t\fR flag, and to disable it, one may specify the \fB-T\fR flag.  
  280. d52 1
  281. a52 1
  282. The kernel's debug level may be modified using the \fB-d\fR  option.
  283. @
  284.  
  285.  
  286. 1.1
  287. log
  288. @Initial revision
  289. @
  290. text
  291. @d1 3
  292. a3 2
  293. ' $Header: /a/newcmds/mig/RCS/mig.man,v 1.1 88/11/21 13:29:02 douglis Exp Locker: douglis $ SPRITE (Berkeley)
  294. .TH migcmd prog
  295. d5 1
  296. a5 1
  297. .NA
  298. d7 2
  299. a8 3
  300. .SY
  301. \fBmigcmd\fR \fI[-marptT]\fR \fI[-P numRecs]\fR \fI[-d debugLevel]\fR
  302. .BE
  303. d18 1
  304. a18 1
  305. may be altered by the \fI-P\fR option.
  306. d21 1
  307. a21 1
  308. option must be used with the \fI-p\fR option.
  309. d28 1
  310. d40 1
  311. a40 1
  312. current host.  This is also done if the \fI-m\fR flag is specified.
  313. d42 1
  314. a42 1
  315. \fI-r\fR  (refuse) and \fI-a\fR (accept) flags, respectively.
  316. d45 1
  317. a45 1
  318. The \fI-p\fR flag may be used to dump process migration trace records.
  319. d47 1
  320. a47 1
  321. the \fI-P\fR option.  By default, tracing is disabled and no trace
  322. d49 1
  323. a49 1
  324. \fI-t\fR flag, and to disable it, one may specify the \fI-T\fR flag.  
  325. d52 1
  326. a52 1
  327. The kernel's debug level may be modified using the \fI-d\fR  option.
  328. d65 1
  329. a65 1
  330. process migration, remote execution, eviction, debug level
  331. @
  332.